GetCurrentScrap

GetCurrentScrap
Header:	Scrap.h		Carbon status:	Supported

Obtains a reference to the current scrap.

OSStatus GetCurrentScrap (
    ScrapRef *scrap
);

Parameter descriptions

scrap: A pointer to a scrap reference. On return, refers to the current scrap.

function result: A result code.

DISCUSSION

Your application can determine if the scrap contents have changed by storing the scrap reference returned by GetCurrentScrap and comparing it against the scrap reference returned by GetCurrentScrap at a later time. If the two scrap references are different, the scrap has changed.

The ScrapRef obtained via GetCurrentScrap becomes invalid and unusable after the scrap is cleared. That is, the scrap reference is valid until a Carbon client calls ClearCurrentScrap or a Classic client calls ZeroScrap or a Cocoa client calls declareTypes:owner:.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.